.. _File And Path Functions:

=======================
File And Path Functions
=======================

.. toctree::
   :maxdepth: 5
   :hidden:
   :glob:

   *

+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| **Function**                                                     | **Description**                                                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_Close<File_Close>`                                    | Close an opened file handle.                                                                                         |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_CreateA<File_CreateA>`                                | Creates a new file from the filename specified.                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_CreateW<File_CreateW>`                                | Creates a new file from the filename specified.                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ExistsA<File_ExistsA>`                                | Tests if a file exists at the path and file name in the zero terminated string.                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ExistsW<File_ExistsW>`                                | Tests if a file exists at the path and file name in the zero terminated string.                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_FileSize<File_FileSize>`                              | Returns the size of a file, from a file handle.                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_Flush<File_Flush>`                                    | Flush a files buffers to disk.                                                                                       |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_MapSharedMemory<File_MapSharedMemory>`                | Create a file mapping for shared memory.                                                                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_OpenA<File_OpenA>`                                    | Opens an existing file from the filename specified.                                                                  |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_OpenW<File_OpenW>`                                    | Opens an existing file from the filename specified.                                                                  |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_Read<File_Read>`                                      | Read a file using a file handle.                                                                                     |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ReadFileToMemoryA<File_ReadFileToMemoryA>`            | Reads a disk file into memory and returns the address and length in two QWORD variables.                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ReadFileToMemoryW<File_ReadFileToMemoryW>`            | Reads a disk file into memory and returns the address and length in two QWORD variables.                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_SizeA<File_SizeA>`                                    | Returns the size of a file if it exists.                                                                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_SizeW<File_SizeW>`                                    | Returns the size of a file if it exists.                                                                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_UnmapSharedMemory<File_UnmapSharedMemory>`            | Unmap a file mapping that was used for shared memory.                                                                |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_Write<File_Write>`                                    | Write a file using a file handle.                                                                                    |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_WriteMemoryToFileA<File_WriteMemoryToFileA>`          | Write the contents of a memory buffer to a disk file.                                                                |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_WriteMemoryToFileW<File_WriteMemoryToFileW>`          | Write the contents of a memory buffer to a disk file.                                                                |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|                                                                  |                                                                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Path_GetAppPath<Path_GetAppPath>`                          | Returns the address of the running application's path as a zero terminated string with the filename removed.         |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Path_GetPathOnly<Path_GetPathOnly>`                        | Reads the path of a complete full filename and path and returns just the path portion in the destination buffer.     |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Path_NameFromPath<Path_NameFromPath>`                      | Reads the filename from a complete path and returns it in the buffer specified.                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+


+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| **ANSI File Function**                                           | **Description**                                                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_CreateA<File_CreateA>`                                | Creates a new file from the filename specified.                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ExistsA<File_ExistsA>`                                | Tests if a file exists at the path and file name in the zero terminated string.                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_OpenA<File_OpenA>`                                    | Opens an existing file from the filename specified.                                                                  |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ReadFileToMemoryA<File_ReadFileToMemoryA>`            | Reads a disk file into memory and returns the address and length in two QWORD variables.                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_SizeA<File_SizeA>`                                    | Returns the size of a file if it exists.                                                                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_WriteMemoryToFileA<File_WriteMemoryToFileA>`          | Write the contents of a memory buffer to a disk file.                                                                |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+


+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| **UNICODE File Function**                                        | **Description**                                                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_CreateW<File_CreateW>`                                | Creates a new file from the filename specified.                                                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ExistsW<File_ExistsW>`                                | Tests if a file exists at the path and file name in the zero terminated string.                                      |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_OpenW<File_OpenW>`                                    | Opens an existing file from the filename specified.                                                                  |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_ReadFileToMemoryW<File_ReadFileToMemoryW>`            | Reads a disk file into memory and returns the address and length in two QWORD variables.                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_SizeA<File_SizeW>`                                    | Returns the size of a file if it exists.                                                                             |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`File_WriteMemoryToFileW<File_WriteMemoryToFileW>`          | Write the contents of a memory buffer to a disk file.                                                                |
+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+